Profiles

[
    {
        "creation_time": 12312321312312,
        "last_modified_time": 213123213123,
        "profile_version": 1,
        "payloads": [
            "restrictionspolicy",
            "passcodepolicy"
        ],
        "last_modified_by": 21312312312312,
        "profile_description": "Test IOS Restrictions Policy",
        "created_by": 21321312312,
        "collection_id": 2132131231241,
        "profile_name": "IOS Restrictions Policy",
        "profile_status": "Yet To Deploy",
        "platform_type": 1,
        "is_moved_to_trash": false,
        "profile_id": 12321312312,
        "scope": 0,
        "profile_status_id": 1
    }
]

Get List of profiles

Get List of profiles
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/profiles

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "profiles": [
        {
            "creation_time": 12312321312312,
            "last_modified_time": 213123213123,
            "profile_version": 1,
            "payloads": [
                "restrictionspolicy",
                "passcodepolicy"
            ],
            "last_modified_by": 21312312312312,
            "profile_description": "Test IOS Restrictions Policy",
            "created_by": 21321312312,
            "collection_id": 2132131231241,
            "profile_name": "IOS Restrictions Policy",
            "profile_status": "Yet To Deploy",
            "platform_type": 1,
            "is_moved_to_trash": false,
            "profile_id": 12321312312,
            "scope": 0,
            "profile_status_id": 1
        }
    ]
}

Create a profile

Create a profile
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/profiles

Arguments

profile_name

string

(Required)

Name of the profile

profile_description

string

Description

platform_type

integer

(Required)

Profile platform type:

iOS
Android
Windows
Chrome

scope

integer

Scope of the profile (default - 0): Android Profile : ( 0 - devices, 1 - knox container)
Chrome Profile : (0 - devices, 2 - user)

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "profile_name": "IOS Restrictions Policy",
    "profile_description": "Test IOS Restrictions Policy",
    "platform_type": 1,
    "scope": 0
}

HTTP/1.1

{
    "creation_time": 12312321312312,
    "last_modified_time": 213123213123,
    "profile_version": 1,
    "payloads": [
        "restrictionspolicy",
        "passcodepolicy"
    ],
    "last_modified_by": 21312312312312,
    "profile_description": "Test IOS Restrictions Policy",
    "created_by": 21321312312,
    "collection_id": 2132131231241,
    "profile_name": "IOS Restrictions Policy",
    "profile_status": "Yet To Deploy",
    "platform_type": 1,
    "is_moved_to_trash": false,
    "profile_id": 12321312312,
    "scope": 0,
    "profile_status_id": 1
}

Trash or delete profile

On first API call the profile is trashed, if profile is already trashed it will be deleted permanently
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/profiles

Arguments

profile_ids

array

(Required)

List of profile IDs

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "profile_ids": [
        1,
        2,
        3
    ]
}

HTTP/1.1

{
    "creation_time": 12312321312312,
    "last_modified_time": 213123213123,
    "profile_version": 1,
    "payloads": [
        "restrictionspolicy",
        "passcodepolicy"
    ],
    "last_modified_by": 21312312312312,
    "profile_description": "Test IOS Restrictions Policy",
    "created_by": 21321312312,
    "collection_id": 2132131231241,
    "profile_name": "IOS Restrictions Policy",
    "profile_status": "Yet To Deploy",
    "platform_type": 1,
    "is_moved_to_trash": false,
    "profile_id": 12321312312,
    "scope": 0,
    "profile_status_id": 1
}

Get Particular profile details

Get Particular profile details
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/profiles/{profile_id}

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "creation_time": 12312321312312,
    "last_modified_time": 213123213123,
    "profile_version": 1,
    "payloads": [
        "restrictionspolicy",
        "passcodepolicy"
    ],
    "last_modified_by": 21312312312312,
    "profile_description": "Test IOS Restrictions Policy",
    "created_by": 21321312312,
    "collection_id": 2132131231241,
    "profile_name": "IOS Restrictions Policy",
    "profile_status": "Yet To Deploy",
    "platform_type": 1,
    "is_moved_to_trash": false,
    "profile_id": 12321312312,
    "scope": 0,
    "profile_status_id": 1
}

Modify a profile

Modify a profile
oauthscope : MDMOnDemand.MDMDeviceMgmt.UDPATE

PUT - /api/v1/mdm/profiles/{profile_id}

Arguments

profile_name

string

Name of the profile

profile_description

string

Description

curl --request PUT \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "profile_name": "IOS Restrictions Policy",
    "profile_description": "Test IOS Restrictions Policy"
}

HTTP/1.1

{
    "creation_time": 12312321312312,
    "last_modified_time": 213123213123,
    "profile_version": 1,
    "payloads": [
        "restrictionspolicy",
        "passcodepolicy"
    ],
    "last_modified_by": 21312312312312,
    "profile_description": "Test IOS Restrictions Policy",
    "created_by": 21321312312,
    "collection_id": 2132131231241,
    "profile_name": "IOS Restrictions Policy",
    "profile_status": "Yet To Deploy",
    "platform_type": 1,
    "is_moved_to_trash": false,
    "profile_id": 12321312312,
    "scope": 0,
    "profile_status_id": 1
}

Get List of payloads

Get List of payloads for profile.
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/profiles/{profile_id}/payloads

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/payloads \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "payloads": [
        "restrictionspolicy",
        "passcodepolicy"
    ]
}

Get payload IDs for particular payload type

Get payload IDs for particular payload type. refer here for payload details
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/payloads/restrictionspolicy \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "payload_name": "restrictionspolicy",
    "payloaditems": [
        "9007199254741295"
    ]
}

Add a payload to the profile

For information regarding the payload request JSON of each payload type please refer here. Example of IOS Passocde Payload is given here.
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}

Arguments

max_passcode_age

integer

Maximum Passcode Age in days. Allowed values : 1-170

require_alphanumeric

boolean

Mandates the use of alphanumeric values as passcode.

max_failed_attempts

integer

Maximum number of failed attempts. The device will be factory reset when the maximum number is exceeded. Allowed values 3-9

min_passcode_length

integer

Minimum passcode length. The user must configure a password longer than the length configured here. Allowed values : 1-16

min_complex_chars

integer

Mandates the minimum number of special characters to be used in the passcode. Allowed values : 1-4

no_of_passcode_maintained

integer

Number of passcodes to be maintained in the history. The user cannot reuse the passcode stored in the history. Allowed values: 1-50

allow_simple_value

boolean

Allow numerical values to be configured as passcode.

auto_lock_idle_for

integer

Maximum idle time allowed before auto-lock. The device user can select any value less than the value configured here. (Allowed valued - 1,2,3,4,5,10,15)

max_grace_period

integer

Maximum time to unlock device without prompting for a passcode (in minutes). Allowed values: 0-240

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/payloads/restrictionspolicy \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0
}

HTTP/1.1

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "payload_id": 123123123
}

Remove Particular payload from profile.

Remove Particular payload from profile. refer here for payload details
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/payloads/restrictionspolicy \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "payload_id": 123123123
}

Get particular payload details

Get particular payload details. For information regarding the payload JSON of each payload type please refer here.
Example of IOS Passocde Payload is given here.
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id}

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/payloads/restrictionspolicy/payloaditems/123123123 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "payload_id": 123123123
}

Modify a payload in the profile

Modify a payload in the profile,For information regarding the payload request JSON of each payload type please refer here. Example of IOS Passocde Payload is given here.
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

PUT - /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id}

Arguments

max_passcode_age

integer

Maximum Passcode Age in days. Allowed values : 1-170

require_alphanumeric

boolean

Mandates the use of alphanumeric values as passcode.

max_failed_attempts

integer

Maximum number of failed attempts. The device will be factory reset when the maximum number is exceeded. Allowed values 3-9

min_passcode_length

integer

Minimum passcode length. The user must configure a password longer than the length configured here. Allowed values : 1-16

min_complex_chars

integer

Mandates the minimum number of special characters to be used in the passcode. Allowed values : 1-4

no_of_passcode_maintained

integer

Number of passcodes to be maintained in the history. The user cannot reuse the passcode stored in the history. Allowed values: 1-50

allow_simple_value

boolean

Allow numerical values to be configured as passcode.

auto_lock_idle_for

integer

Maximum idle time allowed before auto-lock. The device user can select any value less than the value configured here. (Allowed valued - 1,2,3,4,5,10,15)

max_grace_period

integer

Maximum time to unlock device without prompting for a passcode (in minutes). Allowed values: 0-240

curl --request PUT \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/payloads/restrictionspolicy/payloaditems/123123123 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0
}

HTTP/1.1

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "payload_id": 123123123
}

Remove Particular payload item

Remove Particular payload item. refer here for payload details
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/profiles/{profile_id}/payloads/{payload_name}/payloaditems/{payload_id}

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/payloads/restrictionspolicy/payloaditems/123123123 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "payload_id": 123123123
}

Publish a profile

Publish a profile. Every profile needs to published so that it can be distributed
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/profiles/{profile_id}/publish

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/publish \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "payload_id": 123123123
}

Profile Update all

Update a profiles to all devices and groups
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

PUT - /api/v1/mdm/profiles/{profile_id}/update_all

curl --request PUT \
  --url https://www.mdm.manageengine.com/api/v1/mdm/profiles/12321312312/update_all \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "max_passcode_age": 150,
    "require_alphanumeric": true,
    "max_failed_attempts": 9,
    "min_passcode_length": 5,
    "min_complex_chars": 2,
    "no_of_passcode_maintained": 50,
    "allow_simple_value": false,
    "auto_lock_idle_for": 3,
    "max_grace_period": 0,
    "payload_id": 123123123
}